home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / src / tests / fstrash / fstrash.man < prev    next >
Encoding:
Text File  |  1990-07-10  |  9.2 KB  |  239 lines
  1. ' Copyright 1989 Regents of the University of California
  2. ' Permission to use, copy, modify, and distribute this
  3. ' documentation for any purpose and without fee is hereby
  4. ' granted, provided that this notice appears in all copies.
  5. ' The University of California makes no representations about
  6. ' the suitability of this material for any purpose.  It is
  7. ' provided "as is" without express or implied warranty.
  8. ' 
  9. ' $Header: /sprite/src/tests/fstrash/RCS/fstrash.man,v 1.1 90/07/09 21:45:39 jhh Exp Locker: jhh $ SPRITE (Berkeley)
  10. ' 
  11. .so \*(]ltmac.sprite
  12. .HS fstrash cmds
  13. .BS
  14. .SH NAME
  15. fstrash \- Produces a completely trashed filesystem.
  16. .SH SYNOPSIS
  17. .nf
  18. \fBfstrash -dev \fIdevice\fP -part \fIpartition\fP [\fIoptions\fR]
  19. .SH OPTIONS
  20. .IP "\fB\-dev\fI device\fR" 14
  21. \fIDevice\fP is the root name of a device, i.e. rxy0, rsd1, rsb0
  22. .IP "\fB\-part\fI partition\fR" 14
  23. \fIPartition\fP is a letter indicating a partition, i.e. a, b, c, d, e, f, g.
  24. .IP "\fB\-dir\fI devDir\fR" 14
  25. \fIDevDir\fR is an alternate directory in which to find the device file
  26. named by concatenating \fIdevice\fR and \fIpartition\fR.  The default 
  27. directory name is ``/dev/``.
  28. .IP "\fB\-initialPart\fI firstPartName\fR" 14
  29. \fIfirstPartName\fP is the name of the initial partition on the disk
  30. which contains basic disk geometry information.  The default is partition
  31. ``a''.
  32. .IP "\fB\-write\fR" 14
  33. Write the disk.  The default is to
  34. not write the disk.
  35. .IP "\fB\-overlap\fR" 14
  36. Overlap filesystem blocks across track boundaries. The default is to not overlap
  37. blocks.
  38. .IP "\fB\-copySuper\fR" 14
  39. Copy the super block to the partition. The default is to not copy.
  40. .IP "\fB\-ratio\fR" 14
  41. Ratio of Kbytes to file descriptors. The default is 4.
  42. .IP "\fB\-test\fR" 14
  43. Don't write to the disk. This is the default.
  44. .IP "\fB\-freeRoot\fR" 14
  45. Set the flag field in the root file descriptor to indicate that it is free.
  46. The default is to mark the root file descriptor as allocated.
  47. .IP "\fB\-fileRoot\fR" 14
  48. Set the filetype field in the root file descriptor to indicate that it is a
  49. file. The default is to make the root a directory.
  50. .IP "\fB\-noRoot\fR" 14
  51. Zero out both the root file descriptor and data block 0. The default is
  52. to fill in the descriptor and to add files to the root.
  53. This option has precedence over both \fB\-freeRoot\fR and \fB\-fileRoot\fR.
  54. .BE
  55.  
  56. .SH DESCRIPTION
  57. .PP
  58. This program produces a trashed file system. It is intended to be used to
  59. test the \fBfscheck\fR program. The above section illustrates the use of the
  60. options. This section outlines the errors that are built into the filesystem
  61. and the actions \fBfscheck\fR should take to correct those errors.
  62. .SS FILE DESCRIPTORS
  63. .LP
  64. The following is a list of the file descriptors, their status in the
  65. file descriptor bitmap, and the file they represent.
  66. .KS
  67. .DS L
  68. .nf
  69. File #        Name                Status
  70. .sp
  71. 0        not used by filesystem        marked
  72. 1        bad blocks            marked
  73. 2        root                marked
  74. 3        "lost+found"            marked
  75. 4        "testFile"            marked
  76. 5        unreferenced file        unmarked
  77. 6        "tooBig"            marked
  78. 7        "tooSmall"            marked
  79. 8         "holeFile"            marked
  80. 9        "holeDir"            marked
  81. 10        "badIndexFile"            marked
  82. 11        "illegalFrag"            marked
  83. 12        "copyBadFrag"            marked
  84. 13        "copyBlock"            marked
  85. 14        "copyIndBlock"            marked
  86. 15        "copyBogusInd"            marked
  87. 16        unreferenced file        unmarked
  88. 17        unreferenced file        marked
  89. 18        "output"            marked
  90. 20        unused but marked        marked
  91. 21        "badDotDot"            marked
  92. 22        unallocated file (used by 21)    unmarked
  93. .fi
  94. .DE
  95. .KE
  96. .LP
  97. Fscheck should change the file descriptor bitmap to indicate that files 5 and
  98. 16 are allocated and that file 20 is unallocated. 
  99.  
  100. .SS DATA BLOCKS
  101. .LP
  102. The following is a list of the data blocks, their status in the data block
  103. bitmap and the number of the file that uses them. The block numbers are for
  104. 1k blocks so they actually represent fragments. 
  105.  
  106. .KS
  107. .DS L
  108. .nf
  109. Block #            File #            Status
  110. .sp
  111. 0            2            marked
  112. 1            not used        marked
  113. 4 - 9            3            marked
  114. 10            3            unmarked
  115. 11            3            marked
  116. 12 - 15            6            marked
  117. 16 - 17            7            marked
  118. 20 - 31            8            unmarked
  119. 32 - 39            9            marked
  120. 40 - 43            not used
  121. 44 - 47            10            marked
  122. 48 - 51            10,14            marked
  123. 52 - 55            10,14            marked
  124. 56 - 59            10,13,14,15        marked
  125. 60             12            unmarked
  126. 61            11,12            marked
  127. 62            11,12            marked
  128. 63            12            unmarked
  129. 64            17            marked
  130. 68 - 75            18            marked
  131. 76            21            marked
  132. .fi
  133. .DE
  134. .KE
  135. .LP
  136. The following blocks should be marked as in use by \fBfscheck\fR: 10, and 20-31.
  137. The following blocks should be marked as not in use: 1, 36-43, and 61.
  138. If the \fB\-delete\fR option of \fBfscheck\fR is not used, then \fBfscheck\fR 
  139. will 
  140. copy
  141. some of disk blocks. This will result in additional disk blocks being
  142. marked as in use. A total of 5 4k blocks are needed. There are two free 4k
  143. blocks in the range 36-43, so depending upon the \fBfscheck\fR implementation 
  144. these blocks may be reused. This would result in their status remaining
  145. unchanged, while 3 previously unused 4k blocks become used.
  146.  
  147. .SS FILES
  148. .LP 
  149. This section contains a description of the problems with each of the files
  150. created by \fBfstrash\fR and the actions \fBfscheck\fR should take to 
  151. correct them.
  152. .IP "File 1 - bad block file descriptor"
  153. File 1 is for bad blocks on the disk. Fscheck should not modify this descriptor
  154. unless the -badBlock option is given, in which case it should reset the
  155. contents of the descriptor.
  156. .IP "File 2 - \fIRoot\fR"
  157. If none of the "*Root" options are given the root directory should not be
  158. affected by \fBfscheck\fR. 
  159. If the \fB\-fileRoot\fR option is given to \fBfstrash\fR,
  160. then \fBfscheck\fR should reconstruct the root directory by adding file 3 
  161. (lost+found) to the root and updating the link count for file 3.
  162. If the \fB\-freeRoot\fR option is used, then \fBfscheck\fR should mark 
  163. file 2 as
  164. in use in addition to adding file 3 to the root.
  165. The \fB\-noRoot\fR option forces \fBfscheck\fR to do a lot of work 
  166. to fix the root.
  167. First, file 2 has to be marked in use. Secondly, any file that is using block
  168. 0 should either have this block deleted or a copy made. File 3 should be
  169. put in the root, and all other files should be put in file 3.
  170. .IP "File 3 - \fIlost+found\fR"
  171. The \fIlost+found\fR directory should be in the root and 
  172. should have its link count
  173. corrected when file 17 (an unreferenced directory) is added to it.
  174. .IP "File 4 - \fItestFile\fR"
  175. \fItestFile\fR is an empty file that is a child of the root. It should not be 
  176. modified by \fBfscheck\fR.
  177. .IP "File 5 - an unreferenced file"
  178. File 5 is an empty, unreferenced file that should be put into lost+found.
  179. .IP "File 6 - \fItooBig\fR"
  180. The size of the file \fItooBig\fR is greater than the amount of
  181. space in its data
  182. blocks. Its length should be truncated to the size of one direct block (4096
  183. bytes).
  184. .IP "File 7 - \fItooSmall\fR"
  185. The size of the file \fItooSmall\fR is smaller than the amount of space in its
  186. data blocks. Direct block 1 (17) should be deleted and its block count 
  187. corrected
  188. from 2 to 1.
  189. .IP "File 8 - \fIholeFile\fR"
  190. \fIholeFile\fR is a file with a hole in most of its direct blocks. 
  191. \fBfscheck\fR should not
  192. modify this file.
  193. .IP "File 9 - \fIholeDir\fR"
  194. Holes are not allowed in directories, so \fBfscheck\fR should 
  195. fill in the hole with empty entries. The hole is in the second direct block.
  196. .IP "File 10 - \fIbadIndexFile\fR"
  197. The \fIbadIndexFile\fR file has an invalid index in its first indirect block.
  198. This block (44) should be deleted so that the file has a hole, and the block
  199. count should be corrected from 1 to 4.
  200. The first direct block pointer is also invalid and should be made a hole.
  201. .IP "File 11 - \fIillegalFrag\fR"
  202. File 11 has a fragment that is not the last block in the file. This fragment
  203. (61)
  204. should be turned into a hole and the block count corrected from 2 to 1.
  205. .IP "File 12 - \fIcopyBadFrag\fR"
  206. The first direct block in file 12 shares one fragment with file 11. 
  207. It should be copied. The second direct block is a fragment that is also shared
  208. with file 11. Only one fragment's worth of data should be copied.
  209. .IP "File 13 - \fIcopyBlock\fR"
  210. This file contains 2 duplicate blocks. Block 0 is reserved for the root
  211. directory and should be either deleted or copied, even if the root directory
  212. doesn't exist. Block 56 is shared with file 10 and should be either copied
  213. or deleted.
  214. The doubly indirect block pointer is invalid (8). Indirect block pointers
  215. are physical block pointers, so the message about a bad pointer may display
  216. the wrong value. The block should be deleted and the size of the file 
  217. reduced to 8192 bytes.
  218. .IP "File 14 - \fIcopyIndBlock\fR"
  219. File 14 shares the doubly indirect block with file 10. New data blocks should
  220. be allocated for the doubly indirect block (48), the indirect block it contains
  221. (52),
  222. and the direct block it contains (56).
  223. .IP "File 15 - \fIcopyBogusIndBlock\fR"
  224. File 15 shares its doubly indirect block with file 10. Block 56 is not
  225. a valid indirect block and should be 
  226. deleted from file 15.
  227. This leaves file 15 with 0 blocks so it should be truncated to length
  228. 0 and the block count corrected from 1 to 0.
  229. .IP "File 16 - bad magic number"
  230. File 16 has a bad magic number and should be marked as free.
  231. .IP "File 17 - unreferenced directory"
  232. File 17 is an unreferenced directory that should be put in lost+found.
  233. The link counts in lost+found and file 17 should be fixed accordingly.
  234. .IP "File 18 - \fIoutput\fR"
  235. File 18 is the output file for saving the results of running fscheck. It
  236. initially has two data blocks allocated to it.
  237. .SH KEYWORDS
  238. filesystem fscheck fsmake
  239.